package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.TemplateInfoAddDTO;
import org.jsola.hr.dto.TemplateInfoUpdateDTO;
import org.jsola.hr.query.TemplateInfoQuery;
import org.jsola.hr.vo.TemplateInfoListVO;
import org.jsola.hr.vo.TemplateInfoVO;

import java.util.List;

/**
 * @author zhr
 */
@Api(tags = "hr-模板信息")
public interface ITemplateInfoControllerAPI {

    /**
     * 新增模板信息
     * @param templateInfoAddDTO 模板信息新增实体
     * @return 模板信息展示对象
     */
    @ApiOperation(value = "新增模板信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "templateInfoAddDTO", dataType = "TemplateInfoAddDTO", value = "新增模板信息", paramType = "body")
    })
    Result<TemplateInfoVO> save(TemplateInfoAddDTO templateInfoAddDTO);


    /**
     * 修改模板信息
     * @param templateInfoUpdateDTO 模板信息
     * @return 更新数量
     */
    @ApiOperation(value = "修改模板信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "templateInfoUpdateDTO", dataType = "TemplateInfoUpdateDTO", value = "修改模板信息", paramType = "body")
    })
    Result<Integer> update(TemplateInfoUpdateDTO templateInfoUpdateDTO);




    /**
     * 删除单个模板信息，彻底删除
     * @param templateInfoId 模板信息id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个模板信息，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "templateInfoId", dataType = "String", value = "模板信息id", paramType = "path")
    })
    Result<Integer> delete(String templateInfoId);


    /**
     * 批量删除模板信息，彻底删除
     * @param templateInfoIds 模板信息id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除模板信息，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "templateInfoIds", dataType = "String[]", value = "模板信息id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] templateInfoIds);


    /**
     * 根据模板信息id查询模板信息详情
     * @param templateInfoId 模板信息id
     * @return 模板信息详情
     */
    @ApiOperation(value="根据模板信息id查询模板信息详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "templateInfoId", dataType = "String", value = "模板信息id", paramType = "path")
    })
    Result<TemplateInfoVO> findById(String templateInfoId);


    /**
     * 查询模板信息
     * @param templateInfoQuery 模板信息查询参数
     * @return page
     */
    @ApiOperation(value="查询模板信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "templateInfoQuery", dataType = "TemplateInfoQuery", value = "模板信息查询参数", paramType = "query")
    })
    Result<List<TemplateInfoListVO>> listAll(TemplateInfoQuery templateInfoQuery);


     /**
     * 分页查询模板信息
     * @param templateInfoQuery 模板信息查询参数
     * @return page
     */
    @ApiOperation(value="分页查询模板信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "templateInfoQuery", dataType = "TemplateInfoQuery", value = "模板信息查询参数", paramType = "query")
    })
    Result<Page<TemplateInfoListVO>> page(TemplateInfoQuery templateInfoQuery);


}

